Cisco-IOS-XR-ipv4-dhcpd-cfg API API Reference
API generated from Cisco-IOS-XR-ipv4-dhcpd-cfg@2017-09-30.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key Mandatory OptionalPaths
IPV4-DHCPD - Update
Update operation of resource: ipv4-dhcpd
ipv4-dhcpdbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7" "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: 10 minutes)"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": "null", DHCP proxy profile
"snoop": "null", DHCP Snoop profile
"server": "null" DHCP Server profile
}, { "profile-name": "string", Profile Name
"mode": "string" DHCP IPV4 Profile mode
},
"interface-name": "string", Interface Name "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}, "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100"
},
"allow-client-id-change": "null", For BNG session, allow client id change for a\nclient MAC "duplicate-mac": "null", Duplicate mac is allowed
"exclude-vlan": "null", Exclude vlan
"include-giaddr": "null" Include giaddr
}, { "mode": "string", DHCP IPV4 Profile mode
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF Name
}
]
},
"inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7" { { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Create
Create operation of resource: ipv4-dhcpd
ipv4-dhcpdbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7" "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: 10 minutes)"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": "null", DHCP proxy profile
"snoop": "null", DHCP Snoop profile
"server": "null" DHCP Server profile
}, { "profile-name": "string", Profile Name
"mode": "string" DHCP IPV4 Profile mode
},
"interface-name": "string", Interface Name "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}, "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100"
},
"allow-client-id-change": "null", For BNG session, allow client id change for a\nclient MAC "duplicate-mac": "null", Duplicate mac is allowed
"exclude-vlan": "null", Exclude vlan
"include-giaddr": "null" Include giaddr
}, { "mode": "string", DHCP IPV4 Profile mode
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF Name
}
]
},
"inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7" { { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Delete
Delete operation of resource: ipv4-dhcpd
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Retrieve
Retrieve operation of resource: ipv4-dhcpd
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7" "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: 10 minutes)"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": "null", DHCP proxy profile
"snoop": "null", DHCP Snoop profile
"server": "null" DHCP Server profile
}, { "profile-name": "string", Profile Name
"mode": "string" DHCP IPV4 Profile mode
},
"interface-name": "string", Interface Name "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", No description "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Set constant integer
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}, "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100"
},
"allow-client-id-change": "null", For BNG session, allow client id change for a\nclient MAC "duplicate-mac": "null", Duplicate mac is allowed
"exclude-vlan": "null", Exclude vlan
"include-giaddr": "null" Include giaddr
}, { "mode": "string", DHCP IPV4 Profile mode
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF Name
}
]
},
"inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7" { { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name : {Helper addresses : [No description {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
PROFILE - Update
Update operation of resource: profile
profilebody object
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
PROFILES - Update
Update operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILES - Create
Create operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILES - Delete
Delete operation of resource: profiles
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILES - Retrieve
Retrieve operation of resource: profiles
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
PROFILE - Update
Update operation of resource: profile
profilebody object
profile-name:
string
in path
ID of profile-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
profile-name:
string
in path
ID of profile-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
profile-name:
string
in path
ID of profile-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
profile-name:
string
in path
ID of profile-name
200 OK
Successful operation
400 Bad Request
Internal Error
MODES - Update
Update operation of resource: modes
modesbody object
profile-name:
string
in path
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MODES - Create
Create operation of resource: modes
modesbody object
profile-name:
string
in path
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MODES - Delete
Delete operation of resource: modes
profile-name:
string
in path
ID of profile-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MODES - Retrieve
Retrieve operation of resource: modes
profile-name:
string
in path
ID of profile-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
}
}
MODE - Update
Update operation of resource: mode
modebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MODE - Create
Create operation of resource: mode
modebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MODE - Delete
Delete operation of resource: mode
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MODE - Retrieve
Retrieve operation of resource: mode
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Specify broadcast flag policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"class-name": "string", class name "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "string" Match option
},
"vrf": "string" Specify match VRF
}
}
]
}, {
"vrf-name": "string", VRF Name {
"server-address": "string", IPv4 address
"gateway-address": "string" GatewayAddress
}
]
}
}
]
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Specify Relay Agent Information Option\nauthenticate
"option": "null", No description
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Enter remote-id value
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "policy": "string" Specify broadcast flag policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Specify broadcast flag policy
"vpn": "null", Insert VPN options
"check": "null" specify requested-ip-address-check disable
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
}
}, "policy": "string", Specify broadcast flag policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
},
"mode": "string", DHCP IPV4 Profile mode "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
]
}
SNOOP - Update
Update operation of resource: snoop
snoopbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string", Relay information option policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP - Create
Create operation of resource: snoop
snoopbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string", Relay information option policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP - Delete
Delete operation of resource: snoop
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP - Retrieve
Retrieve operation of resource: snoop
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "string", Relay information option policy
"insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": "null" Forward untrusted packets
},
"trusted": "null" Trusted sources
}
}
RELAY-INFORMATION-OPTION - Update
Update operation of resource: relay-information-option
relay-information-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Create
Create operation of resource: relay-information-option
relay-information-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Delete
Delete operation of resource: relay-information-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Retrieve
Retrieve operation of resource: relay-information-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}
}
REMOTE-ID - Update
Update operation of resource: remote-id
remote-idbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-ID - Create
Create operation of resource: remote-id
remote-idbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-ID - Delete
Delete operation of resource: remote-id
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REMOTE-ID - Retrieve
Retrieve operation of resource: remote-id
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
BASE - Update
Update operation of resource: base
basebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable the DHCP IPv4 Base Profile {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE - Create
Create operation of resource: base
basebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable the DHCP IPv4 Base Profile {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE - Delete
Delete operation of resource: base
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE - Retrieve
Retrieve operation of resource: base
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile-name": "string", Profile name
"profile-mode": "integer" none
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
},
"enable": "null", Enable the DHCP IPv4 Base Profile {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "string", Vendor action
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
}
DEFAULT-PROFILE - Update
Update operation of resource: default-profile
default-profilebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Create
Create operation of resource: default-profile
default-profilebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Delete
Delete operation of resource: default-profile
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Retrieve
Retrieve operation of resource: default-profile
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
OPTION-FILTERS - Update
Update operation of resource: option-filters
option-filtersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Create
Create operation of resource: option-filters
option-filtersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Delete
Delete operation of resource: option-filters
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Retrieve
Retrieve operation of resource: option-filters
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
OPTION-FILTER - Update
Update operation of resource: option-filter
option-filterbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Create
Create operation of resource: option-filter
option-filterbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Delete
Delete operation of resource: option-filter
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Retrieve
Retrieve operation of resource: option-filter
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
DEF-OPTIONS - Update
Update operation of resource: def-options
def-optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Create
Create operation of resource: def-options
def-optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Delete
Delete operation of resource: def-options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Retrieve
Retrieve operation of resource: def-options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
DEF-OPTION - Update
Update operation of resource: def-option
def-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTION - Create
Create operation of resource: def-option
def-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTION - Delete
Delete operation of resource: def-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTION - Retrieve
Retrieve operation of resource: def-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
BASE-RELAY-OPT - Update
Update operation of resource: base-relay-opt
base-relay-optbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Create
Create operation of resource: base-relay-opt
base-relay-optbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Delete
Delete operation of resource: base-relay-opt
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Retrieve
Retrieve operation of resource: base-relay-opt
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}
}
BASE-MATCH - Update
Update operation of resource: base-match
base-matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-MATCH - Create
Create operation of resource: base-match
base-matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-MATCH - Delete
Delete operation of resource: base-match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-MATCH - Retrieve
Retrieve operation of resource: base-match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
OPTIONS - Update
Update operation of resource: options
optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTIONS - Create
Create operation of resource: options
optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTIONS - Delete
Delete operation of resource: options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTIONS - Retrieve
Retrieve operation of resource: options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match option 60
"format": "integer" Set constant integer
}
]
}
}
OPTION - Update
Update operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
OPTION-PROFILE - Update
Update operation of resource: option-profile
option-profilebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Create
Create operation of resource: option-profile
option-profilebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Delete
Delete operation of resource: option-profile
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Retrieve
Retrieve operation of resource: option-profile
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
opt60 opt60-hex-str format:
string
in path
ID of opt60 opt60-hex-str format
200 OK
Successful operation
400 Bad Request
Internal Error
SERVER - Update
Update operation of resource: server
serverbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER - Create
Create operation of resource: server
serverbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER - Delete
Delete operation of resource: server
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER - Retrieve
Retrieve operation of resource: server
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
},
"subnet-mask": "string", Configure Subnet Mask { "option-number": "integer", Option number
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}
],
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"check": "null" specify requested-ip-address-check disable
}
], {
"matchaction": "string", Vendor action
"matchoption": "string" Match options
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match options
"format": "integer" Set constant integer
}
]
}
}, "infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
},
"server-allow-move": "null", Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "string" Configure Lease limit value
},
"secure-arp": "null", Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
},
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "policy": "string" Specify broadcast flag policy
}, "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "force-insert": "null" Set constant integer
}
}, "check": "null" specify requested-ip-address-check disable
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"default-router": "string" Router's IP address
}
], {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
],
"enable": "null", Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"next-server": "string", Configure the tftp-server IP to be used\nby the client "dns-server": "string" DNS Server's IP address
}, {
"net-bios-name-server": "string" NetBIOSNameServer's IP address
}
],
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "1..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
}
SERVER-ID-CHECK - Update
Update operation of resource: server-id-check
server-id-checkbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Create
Create operation of resource: server-id-check
server-id-checkbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Delete
Delete operation of resource: server-id-check
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Retrieve
Retrieve operation of resource: server-id-check
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
LEASE-LIMIT - Update
Update operation of resource: lease-limit
lease-limitbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Create
Create operation of resource: lease-limit
lease-limitbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Delete
Delete operation of resource: lease-limit
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Retrieve
Retrieve operation of resource: lease-limit
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
REQUESTED-IP-ADDRESS - Update
Update operation of resource: requested-ip-address
requested-ip-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Create
Create operation of resource: requested-ip-address
requested-ip-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Delete
Delete operation of resource: requested-ip-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Retrieve
Retrieve operation of resource: requested-ip-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
AAA-SERVER - Update
Update operation of resource: aaa-server
aaa-serverbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AAA-SERVER - Create
Create operation of resource: aaa-server
aaa-serverbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AAA-SERVER - Delete
Delete operation of resource: aaa-server
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AAA-SERVER - Retrieve
Retrieve operation of resource: aaa-server
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
DHCP-OPTION - Update
Update operation of resource: dhcp-option
dhcp-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Create
Create operation of resource: dhcp-option
dhcp-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Delete
Delete operation of resource: dhcp-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Retrieve
Retrieve operation of resource: dhcp-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
DEFAULT-ROUTERS - Update
Update operation of resource: default-routers
default-routersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Create
Create operation of resource: default-routers
default-routersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Delete
Delete operation of resource: default-routers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Retrieve
Retrieve operation of resource: default-routers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
NET-BIOS-NAME-SERVERS - Update
Update operation of resource: net-bios-name-servers
net-bios-name-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Create
Create operation of resource: net-bios-name-servers
net-bios-name-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Delete
Delete operation of resource: net-bios-name-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Retrieve
Retrieve operation of resource: net-bios-name-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ : {Table of Option : [No description {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, : {Table of Option : [No description {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ : {Table of Option : [No description {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, : {Table of Option : [No description {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Table of Option : [No description {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, : {Table of Option : [No description {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
OPTION-DEFAULTS - Update
Update operation of resource: option-defaults
option-defaultsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Create
Create operation of resource: option-defaults
option-defaultsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Delete
Delete operation of resource: option-defaults
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Retrieve
Retrieve operation of resource: option-defaults
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
OPTION-DEFAULT - Update
Update operation of resource: option-default
option-defaultbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Create
Create operation of resource: option-default
option-defaultbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Delete
Delete operation of resource: option-default
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Retrieve
Retrieve operation of resource: option-default
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
OPTIONS - Update
Update operation of resource: options
optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTIONS - Create
Create operation of resource: options
optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTIONS - Delete
Delete operation of resource: options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTIONS - Retrieve
Retrieve operation of resource: options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "string", Match option 60
"format": "integer" Set constant integer
}
]
}
}
OPTION - Update
Update operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
BROADCAST-FLAG - Update
Update operation of resource: broadcast-flag
broadcast-flagbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Create
Create operation of resource: broadcast-flag
broadcast-flagbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Delete
Delete operation of resource: broadcast-flag
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Retrieve
Retrieve operation of resource: broadcast-flag
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
SESSION - Update
Update operation of resource: session
sessionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
THROTTLE-TYPE - Update
Update operation of resource: throttle-type
throttle-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Create
Create operation of resource: throttle-type
throttle-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Delete
Delete operation of resource: throttle-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Retrieve
Retrieve operation of resource: throttle-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
MAC-THROTTLE - Update
Update operation of resource: mac-throttle
mac-throttlebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Create
Create operation of resource: mac-throttle
mac-throttlebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Delete
Delete operation of resource: mac-throttle
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Retrieve
Retrieve operation of resource: mac-throttle
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
CLASSES - Update
Update operation of resource: classes
classesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class : {List of VRFs : [Match VRF name {
"vrf-name": "string", VRF name : {Helper addresses : [No description {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : {Match option : {Match option "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASSES - Create
Create operation of resource: classes
classesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class : {List of VRFs : [Match VRF name {
"vrf-name": "string", VRF name : {Helper addresses : [No description {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : {Match option : {Match option "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASSES - Delete
Delete operation of resource: classes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASSES - Retrieve
Retrieve operation of resource: classes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable the DHCP IPV4 proxy class : {List of VRFs : [Match VRF name {
"vrf-name": "string", VRF name : {Helper addresses : [No description {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : {Match option : {Match option "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
}
CLASS - Update
Update operation of resource: class
classbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class : {List of VRFs : [Match VRF name {
"vrf-name": "string", VRF name : {Helper addresses : [No description {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : {Match option : {Match option "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS - Create
Create operation of resource: class
classbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class : {List of VRFs : [Match VRF name {
"vrf-name": "string", VRF name : {Helper addresses : [No description {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : {Match option : {Match option "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS - Delete
Delete operation of resource: class
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS - Retrieve
Retrieve operation of resource: class
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable the DHCP IPV4 proxy class : {List of VRFs : [Match VRF name {
"vrf-name": "string", VRF name : {Helper addresses : [No description {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : {Match option : {Match option "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
DEFAULT-ROUTERS - Update
Update operation of resource: default-routers
default-routersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Create
Create operation of resource: default-routers
default-routersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Delete
Delete operation of resource: default-routers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Retrieve
Retrieve operation of resource: default-routers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
NET-BIOS-NAME-SERVERS - Update
Update operation of resource: net-bios-name-servers
net-bios-name-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Create
Create operation of resource: net-bios-name-servers
net-bios-name-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Delete
Delete operation of resource: net-bios-name-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Retrieve
Retrieve operation of resource: net-bios-name-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
CLASS-MATCH - Update
Update operation of resource: class-match
class-matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ "l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Create
Create operation of resource: class-match
class-matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ "l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Delete
Delete operation of resource: class-match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Retrieve
Retrieve operation of resource: class-match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "string", Match options
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
}
CLASS-OPTIONS - Update
Update operation of resource: class-options
class-optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Create
Create operation of resource: class-options
class-optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Delete
Delete operation of resource: class-options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Retrieve
Retrieve operation of resource: class-options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
CLASS-OPTION - Update
Update operation of resource: class-option
class-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Create
Create operation of resource: class-option
class-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Delete
Delete operation of resource: class-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Retrieve
Retrieve operation of resource: class-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
matchoption:
string
in path
ID of matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
LEASE - Update
Update operation of resource: lease
leasebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE - Create
Create operation of resource: lease
leasebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE - Delete
Delete operation of resource: lease
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE - Retrieve
Retrieve operation of resource: lease
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
NETBIOS-NODE-TYPE - Update
Update operation of resource: netbios-node-type
netbios-node-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Create
Create operation of resource: netbios-node-type
netbios-node-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Delete
Delete operation of resource: netbios-node-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Retrieve
Retrieve operation of resource: netbios-node-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
}
DNS-SERVERS - Update
Update operation of resource: dns-servers
dns-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Create
Create operation of resource: dns-servers
dns-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Delete
Delete operation of resource: dns-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Retrieve
Retrieve operation of resource: dns-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
OPTION-CODES - Update
Update operation of resource: option-codes
option-codesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODES - Create
Create operation of resource: option-codes
option-codesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODES - Delete
Delete operation of resource: option-codes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODES - Retrieve
Retrieve operation of resource: option-codes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
OPTION-CODE - Update
Update operation of resource: option-code
option-codebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
option-code:
string
in path
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODE - Create
Create operation of resource: option-code
option-codebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
option-code:
string
in path
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODE - Delete
Delete operation of resource: option-code
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
option-code:
string
in path
ID of option-code
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODE - Retrieve
Retrieve operation of resource: option-code
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
option-code:
string
in path
ID of option-code
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
RELAY - Update
Update operation of resource: relay
relaybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ : {GIADDR policy "policy": "string" Relay information option policy
}, : {Broadcast Flag policy "policy": "string" Relay information option policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match : {Relay agent information option "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}, : {VRF Helper Addresses : [No description {
"vrf-name": "string", VRF Name : {Helper Addresses : [No description {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY - Create
Create operation of resource: relay
relaybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ : {GIADDR policy "policy": "string" Relay information option policy
}, : {Broadcast Flag policy "policy": "string" Relay information option policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match : {Relay agent information option "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}, : {VRF Helper Addresses : [No description {
"vrf-name": "string", VRF Name : {Helper Addresses : [No description {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY - Delete
Delete operation of resource: relay
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY - Retrieve
Retrieve operation of resource: relay
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {GIADDR policy "policy": "string" Relay information option policy
}, : {Broadcast Flag policy "policy": "string" Relay information option policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match : {Relay agent information option "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}, : {VRF Helper Addresses : [No description {
"vrf-name": "string", VRF Name : {Helper Addresses : [No description {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
}
LEASE - Update
Update operation of resource: lease
leasebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE - Create
Create operation of resource: lease
leasebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE - Delete
Delete operation of resource: lease
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE - Retrieve
Retrieve operation of resource: lease
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
NETBIOS-NODE-TYPE - Update
Update operation of resource: netbios-node-type
netbios-node-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Create
Create operation of resource: netbios-node-type
netbios-node-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Delete
Delete operation of resource: netbios-node-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Retrieve
Retrieve operation of resource: netbios-node-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
}
DNS-SERVERS - Update
Update operation of resource: dns-servers
dns-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Create
Create operation of resource: dns-servers
dns-serversbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Delete
Delete operation of resource: dns-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Retrieve
Retrieve operation of resource: dns-servers
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
DHCP-TO-AAA - Update
Update operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Create
Create operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Delete
Delete operation of resource: dhcp-to-aaa
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Retrieve
Retrieve operation of resource: dhcp-to-aaa
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
OPTION - Update
Update operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
LIST - Update
Update operation of resource: list
listbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIST - Create
Create operation of resource: list
listbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIST - Delete
Delete operation of resource: list
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIST - Retrieve
Retrieve operation of resource: list
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
OPTION-CODES - Update
Update operation of resource: option-codes
option-codesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODES - Create
Create operation of resource: option-codes
option-codesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODES - Delete
Delete operation of resource: option-codes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODES - Retrieve
Retrieve operation of resource: option-codes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
OPTION-CODE - Update
Update operation of resource: option-code
option-codebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
option-code:
string
in path
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODE - Create
Create operation of resource: option-code
option-codebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
option-code:
string
in path
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODE - Delete
Delete operation of resource: option-code
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
option-code:
string
in path
ID of option-code
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-CODE - Retrieve
Retrieve operation of resource: option-code
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
option-code:
string
in path
ID of option-code
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
RELAY - Update
Update operation of resource: relay
relaybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string" Relay information option policy
}, "policy": "string" Relay information option policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY - Create
Create operation of resource: relay
relaybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "string" Relay information option policy
}, "policy": "string" Relay information option policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY - Delete
Delete operation of resource: relay
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY - Retrieve
Retrieve operation of resource: relay
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "string" Relay information option policy
}, "policy": "string" Relay information option policy
},
"mac-mismatch-action": "string", Action to take if L2 header source Mac and\ndhcp header mac address don't match "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": "null", Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
}
GI-ADDR-POLICY - Update
Update operation of resource: gi-addr-policy
gi-addr-policybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Create
Create operation of resource: gi-addr-policy
gi-addr-policybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Delete
Delete operation of resource: gi-addr-policy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Retrieve
Retrieve operation of resource: gi-addr-policy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
ip-address:
string
in path
ID of ip-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
ip-address:
string
in path
ID of ip-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
ip-address:
string
in path
ID of ip-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
ip-address:
string
in path
ID of ip-address
200 OK
Successful operation
400 Bad Request
Internal Error
RELAY-INFORMATION-OPTION - Update
Update operation of resource: relay-information-option
relay-information-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Create
Create operation of resource: relay-information-option
relay-information-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Delete
Delete operation of resource: relay-information-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Retrieve
Retrieve operation of resource: relay-information-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "insert": "null", Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "string", VPN Mode
"allow-untrusted": "null", Forward untrusted packets
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check Relay Agent Information Option in\nserver reply
}
}
BROADCAST-POLICY - Update
Update operation of resource: broadcast-policy
broadcast-policybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Create
Create operation of resource: broadcast-policy
broadcast-policybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Delete
Delete operation of resource: broadcast-policy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Retrieve
Retrieve operation of resource: broadcast-policy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
PROXY - Update
Update operation of resource: proxy
proxybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", DHCP IPV4 profile proxy secure-arp enable "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Relay information option policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", DHCP IPV4 profile mode enable {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" No description
}
}
]
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"enable": "null", DHCP IPV4 profile mode enable "policy": "string" Relay information option policy
}, : { "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"option-all": "integer" option all
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Relay information option authenticate
"option": "null", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Remote ID
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check relay agent information option in\nserver reply
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY - Create
Create operation of resource: proxy
proxybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", DHCP IPV4 profile proxy secure-arp enable "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Relay information option policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", DHCP IPV4 profile mode enable {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" No description
}
}
]
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"enable": "null", DHCP IPV4 profile mode enable "policy": "string" Relay information option policy
}, : { "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"option-all": "integer" option all
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Relay information option authenticate
"option": "null", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Remote ID
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check relay agent information option in\nserver reply
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY - Delete
Delete operation of resource: proxy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY - Retrieve
Retrieve operation of resource: proxy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "proxy-allow-move": "null", Allow dhcp subscriber move "limit-lease-count": "string", Limit lease count
"limit-type": "string" Lease limit type
},
"secure-arp": "null", DHCP IPV4 profile proxy secure-arp enable "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
},
"delayed-authen-proxy": "null", For BNG session, delay the authentication "arg1": "string", Username Formatting first argument
"arg2": "string" Username Formatting second argument
}, "policy": "string" Relay information option policy
}, "set-server-options": "null", Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"enable": "null", DHCP IPV4 profile mode enable {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name : { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" No description
}
}
]
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"enable": "null", DHCP IPV4 profile mode enable "policy": "string" Relay information option policy
}, : { "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"option-all": "integer" option all
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
], "authenticate": "string", Relay information option authenticate
"option": "null", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Remote ID
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check relay agent information option in\nserver reply
}
}
}
GIADDR - Update
Update operation of resource: giaddr
giaddrbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
GIADDR - Create
Create operation of resource: giaddr
giaddrbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
GIADDR - Delete
Delete operation of resource: giaddr
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
GIADDR - Retrieve
Retrieve operation of resource: giaddr
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
CLASSES - Update
Update operation of resource: classes
classesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASSES - Create
Create operation of resource: classes
classesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASSES - Delete
Delete operation of resource: classes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASSES - Retrieve
Retrieve operation of resource: classes
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable the DHCP IPV4 proxy class {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
}
CLASS - Update
Update operation of resource: class
classbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS - Create
Create operation of resource: class
classbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"enable": "null", Enable the DHCP IPV4 proxy class {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS - Delete
Delete operation of resource: class
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CLASS - Retrieve
Retrieve operation of resource: class
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": "null", Enable the DHCP IPV4 proxy class {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"class-name": "string", Class name "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "string" Match option
},
"vrf": "string" Match VRF name
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ : {Table of Option : [No description {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, : {Table of Option : [No description {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ : {Table of Option : [No description {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, : {Table of Option : [No description {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Table of Option : [No description {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, : {Table of Option : [No description {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
OPTION - Update
Update operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
class-name:
string
in path
ID of class-name
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
AUTH-USERNAME - Update
Update operation of resource: auth-username
auth-usernamebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Create
Create operation of resource: auth-username
auth-usernamebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Delete
Delete operation of resource: auth-username
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Retrieve
Retrieve operation of resource: auth-username
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
RELAY-INFORMATION - Update
Update operation of resource: relay-information
relay-informationbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "authenticate": "string", Relay information option authenticate
"option": "null", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Remote ID
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check relay agent information option in\nserver reply
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Create
Create operation of resource: relay-information
relay-informationbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "authenticate": "string", Relay information option authenticate
"option": "null", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Remote ID
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check relay agent information option in\nserver reply
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Delete
Delete operation of resource: relay-information
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Retrieve
Retrieve operation of resource: relay-information
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authenticate": "string", Relay information option authenticate
"option": "null", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"remote-id-xr": "null", Insert Remote-id sub-option
"allow-untrusted": "null", Forward untrusted packets
"remote-id-suppress": "null", Suppress Remote ID
"vpn-mode": "string", VPN Mode
"remote-id": "string", Remote ID
"circuit-id": "null", Insert Circuit-id sub-option
"policy": "string", Relay information option policy
"vpn": "null", Insert VPN options
"check": "null" Check relay agent information option in\nserver reply
}
}
DHCP-TO-AAA - Update
Update operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Create
Create operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Delete
Delete operation of resource: dhcp-to-aaa
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Retrieve
Retrieve operation of resource: dhcp-to-aaa
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
OPTION - Update
Update operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
LIST - Update
Update operation of resource: list
listbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIST - Create
Create operation of resource: list
listbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIST - Delete
Delete operation of resource: list
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIST - Retrieve
Retrieve operation of resource: list
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
vrf-name:
string
in path
ID of vrf-name
server-address:
string
in path
ID of server-address
200 OK
Successful operation
400 Bad Request
Internal Error
SESSIONS - Update
Update operation of resource: sessions
sessionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SESSIONS - Create
Create operation of resource: sessions
sessionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SESSIONS - Delete
Delete operation of resource: sessions
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SESSIONS - Retrieve
Retrieve operation of resource: sessions
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
PROXY-THROTTLE-TYPE - Update
Update operation of resource: proxy-throttle-type
proxy-throttle-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Create
Create operation of resource: proxy-throttle-type
proxy-throttle-typebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Delete
Delete operation of resource: proxy-throttle-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Retrieve
Retrieve operation of resource: proxy-throttle-type
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
PROXY-MAC-THROTTLE - Update
Update operation of resource: proxy-mac-throttle
proxy-mac-throttlebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Create
Create operation of resource: proxy-mac-throttle
proxy-mac-throttlebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Delete
Delete operation of resource: proxy-mac-throttle
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Retrieve
Retrieve operation of resource: proxy-mac-throttle
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "0..1000"
default: "100"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
LIMIT-LEASE - Update
Update operation of resource: limit-lease
limit-leasebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Create
Create operation of resource: limit-lease
limit-leasebody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Delete
Delete operation of resource: limit-lease
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Retrieve
Retrieve operation of resource: limit-lease
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
LEASE-PROXY - Update
Update operation of resource: lease-proxy
lease-proxybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Create
Create operation of resource: lease-proxy
lease-proxybody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Delete
Delete operation of resource: lease-proxy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Retrieve
Retrieve operation of resource: lease-proxy
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
BROADCAST-FLAG - Update
Update operation of resource: broadcast-flag
broadcast-flagbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Create
Create operation of resource: broadcast-flag
broadcast-flagbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Delete
Delete operation of resource: broadcast-flag
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Retrieve
Retrieve operation of resource: broadcast-flag
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "string", Vendor action
"def-matchoption": "integer" Match option 60
}
]
}
}
}
DEF-OPTIONS - Update
Update operation of resource: def-options
def-optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Create
Create operation of resource: def-options
def-optionsbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Delete
Delete operation of resource: def-options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Retrieve
Retrieve operation of resource: def-options
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
DEF-OPTION - Update
Update operation of resource: def-option
def-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTION - Create
Create operation of resource: def-option
def-optionbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTION - Delete
Delete operation of resource: def-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DEF-OPTION - Retrieve
Retrieve operation of resource: def-option
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
def-matchoption:
string
in path
ID of def-matchoption
200 OK
Successful operation
400 Bad Request
Internal Error
OPTION-FILTERS - Update
Update operation of resource: option-filters
option-filtersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Create
Create operation of resource: option-filters
option-filtersbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Delete
Delete operation of resource: option-filters
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Retrieve
Retrieve operation of resource: option-filters
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "string", Vendor action
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
OPTION-FILTER - Update
Update operation of resource: option-filter
option-filterbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Create
Create operation of resource: option-filter
option-filterbody object
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Delete
Delete operation of resource: option-filter
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Retrieve
Retrieve operation of resource: option-filter
profile-name:
string
in path
ID of profile-name
mode:
string
in path
ID of mode
matchoption pattern format:
string
in path
ID of matchoption pattern format
200 OK
Successful operation
400 Bad Request
Internal Error
DATABASE - Update
Update operation of resource: database
databasebody object
Request Content-Types: application/json
Request Example
{ "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: 10 minutes)"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": "null", Enable DHCP proxy binding database storage to\nfile system
"snoop": "null", Enable DHCP snoop binding database storage to\nfile system
"server": "null" Enable DHCP server binding database storage to\nfile system
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DATABASE - Create
Create operation of resource: database
databasebody object
Request Content-Types: application/json
Request Example
{ "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: 10 minutes)"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": "null", Enable DHCP proxy binding database storage to\nfile system
"snoop": "null", Enable DHCP snoop binding database storage to\nfile system
"server": "null" Enable DHCP server binding database storage to\nfile system
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DATABASE - Delete
Delete operation of resource: database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DATABASE - Retrieve
Retrieve operation of resource: database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: 10 minutes)"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": "null", Enable DHCP proxy binding database storage to\nfile system
"snoop": "null", Enable DHCP snoop binding database storage to\nfile system
"server": "null" Enable DHCP server binding database storage to\nfile system
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { "profile-name": "string", Profile name
"mode": "string" DHCP mode
},
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { "profile-name": "string", Profile name
"mode": "string" DHCP mode
},
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "profile-name": "string", Profile name
"mode": "string" DHCP mode
},
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "profile-name": "string", Profile name
"mode": "string" DHCP mode
},
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "profile-name": "string", Profile name
"mode": "string" DHCP mode
},
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "profile-name": "string", Profile name
"mode": "string" DHCP mode
},
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
PROXY-INTERFACE - Update
Update operation of resource: proxy-interface
proxy-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Create
Create operation of resource: proxy-interface
proxy-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Delete
Delete operation of resource: proxy-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Retrieve
Retrieve operation of resource: proxy-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
DHCP-CIRCUIT-ID - Update
Update operation of resource: dhcp-circuit-id
dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Create
Create operation of resource: dhcp-circuit-id
dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Delete
Delete operation of resource: dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
BASE-INTERFACE - Update
Update operation of resource: base-interface
base-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Create
Create operation of resource: base-interface
base-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Delete
Delete operation of resource: base-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Retrieve
Retrieve operation of resource: base-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
BASE-DHCP-CIRCUIT-ID - Update
Update operation of resource: base-dhcp-circuit-id
base-dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Create
Create operation of resource: base-dhcp-circuit-id
base-dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: base-dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: base-dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
RELAY-INTERFACE - Update
Update operation of resource: relay-interface
relay-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Create
Create operation of resource: relay-interface
relay-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Delete
Delete operation of resource: relay-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Retrieve
Retrieve operation of resource: relay-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
RELAY-DHCP-CIRCUIT-ID - Update
Update operation of resource: relay-dhcp-circuit-id
relay-dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Create
Create operation of resource: relay-dhcp-circuit-id
relay-dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: relay-dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: relay-dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
STATIC-MODE - Update
Update operation of resource: static-mode
static-modebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATIC-MODE - Create
Create operation of resource: static-mode
static-modebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATIC-MODE - Delete
Delete operation of resource: static-mode
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATIC-MODE - Retrieve
Retrieve operation of resource: static-mode
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
}
STATICS - Update
Update operation of resource: statics
staticsbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATICS - Create
Create operation of resource: statics
staticsbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATICS - Delete
Delete operation of resource: statics
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATICS - Retrieve
Retrieve operation of resource: statics
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"client-id": "string", Client Id
"layer": "string", DHCP IPV4 Static layer
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
STATIC - Update
Update operation of resource: static
staticbody object
interface-name:
string
in path
ID of interface-name
mac-address client-id layer:
string
in path
ID of mac-address client-id layer
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATIC - Create
Create operation of resource: static
staticbody object
interface-name:
string
in path
ID of interface-name
mac-address client-id layer:
string
in path
ID of mac-address client-id layer
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATIC - Delete
Delete operation of resource: static
interface-name:
string
in path
ID of interface-name
mac-address client-id layer:
string
in path
ID of mac-address client-id layer
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
STATIC - Retrieve
Retrieve operation of resource: static
interface-name:
string
in path
ID of interface-name
mac-address client-id layer:
string
in path
ID of mac-address client-id layer
200 OK
Successful operation
400 Bad Request
Internal Error
PROFILE - Update
Update operation of resource: profile
profilebody object
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
SERVER-INTERFACE - Update
Update operation of resource: server-interface
server-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Create
Create operation of resource: server-interface
server-interfacebody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Delete
Delete operation of resource: server-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Retrieve
Retrieve operation of resource: server-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile": "string", Interface profile name "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
}
SERVER-DHCP-CIRCUIT-ID - Update
Update operation of resource: server-dhcp-circuit-id
server-dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Create
Create operation of resource: server-dhcp-circuit-id
server-dhcp-circuit-idbody object
interface-name:
string
in path
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: server-dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: server-dhcp-circuit-id
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "string", Argument
"argument11": "string", Argument
"argument12": "string", Argument
"argument13": "string", Argument
"argument14": "string", Argument
"argument15": "string", Argument
"argument16": "string", Argument
"format": "string", Format String
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "string", Argument
"argument7": "string", Argument
"argument4": "string", Argument
"argument5": "string", Argument
"argument2": "string", Argument
"argument3": "string", Argument
"argument1": "string", Argument
"argument8": "string", Argument
"argument9": "string" Argument
}
}
SNOOP-INTERFACE - Update
Update operation of resource: snoop-interface
snoop-interfacebody object
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Create
Create operation of resource: snoop-interface
snoop-interfacebody object
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Delete
Delete operation of resource: snoop-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Retrieve
Retrieve operation of resource: snoop-interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
SNOOP-CIRCUIT-ID - Update
Update operation of resource: snoop-circuit-id
snoop-circuit-idbody object
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Create
Create operation of resource: snoop-circuit-id
snoop-circuit-idbody object
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Delete
Delete operation of resource: snoop-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: snoop-circuit-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
DUPLICATE-MAC-ALLOWED - Update
Update operation of resource: duplicate-mac-allowed
duplicate-mac-allowedbody object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Create
Create operation of resource: duplicate-mac-allowed
duplicate-mac-allowedbody object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Delete
Delete operation of resource: duplicate-mac-allowed
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Retrieve
Retrieve operation of resource: duplicate-mac-allowed
200 OK
Successful operation
400 Bad Request
Internal Error
RATE-LIMIT - Update
Update operation of resource: rate-limit
rate-limitbody object
Request Content-Types: application/json
Request Example
{ "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Create
Create operation of resource: rate-limit
rate-limitbody object
Request Content-Types: application/json
Request Example
{ "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Delete
Delete operation of resource: rate-limit
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Retrieve
Retrieve operation of resource: rate-limit
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100"
}
}